Skip to main content
GET
/
channels
/
{id}
Get channel
curl --request GET \
  --url https://api.example.com/channels/{id}
{
  "data": {
    "id": "app",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Mobile app",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "App landing page",
      "entity": "CHANNELS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "hero_title",
          "type": "TEXT",
          "label": { "en_us": "Hero title" },
          "required": true,
          "value": "Order from our app"
        }
      ]
    }
  }
}
Returns one channel by external id. Use this endpoint after the customer selects a channel to load its name, status, and CMS content for the storefront.
Requires a Fire spark access token obtained through token exchange.

​
Path parameters

ParameterRequiredDescription
idYesExternal channel identifier. Alphanumeric characters, _, and - only. 1–64 characters.

​
Request

curl "https://firespark.vercel.app/api/storefront/v1/channels/app" \
  -H "Authorization: Bearer ACCESS_TOKEN"

​
Response

The response wraps a single channel object in data. The shape matches list channels. 
{
  "data": {
    "id": "app",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Mobile app",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "App landing page",
      "entity": "CHANNELS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "hero_title",
          "type": "TEXT",
          "label": { "en_us": "Hero title" },
          "required": true,
          "value": "Order from our app"
        }
      ]
    }
  }
}

​
Channel fields

See list channels for the full schema, including cms_template_id and cms.
Use the channel id when loading menus and stores scoped to a specific ordering surface.

​
Error responses

StatusDescription
401Missing or invalid access token.
403Token does not have access to this channel.
404No channel found with the given id.